/**
 * Copyright 2010 Adam Ruggles.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package saig.engine;

import java.awt.Point;

import saig.engine.models.enums.ModelType;

/**
 * Game Context interface, this interface exposes certain engine methods to the models.
 * @author Adam
 * @version $Id$
 * 
 * Created on Jul 11, 2010 at 3:24:16 PM 
 */
public interface Context {
	/**
	 * A Button (Jump).
	 */
	int KEY_A = 3;
	/**
	 * B Button (accelerate, throw fireballs).
	 */
	int KEY_B = 4;
	/**
	 * Crouch, Slide.
	 */
	int KEY_DOWN = 2;
	/**
	 * Move left.
	 */
	int KEY_LEFT = 0;
	/**
	 * Move right.
	 */
	int KEY_RIGHT = 1;
	/**
	 * The total number of input keys.
	 */
	int NUMBER_OF_KEYS = 5;
	/**
	 * Returns keyState.
	 * @return the keyState.
	 */
	boolean[] getKeyState();
	/**
	 * Returns the current game environment.
	 * @return The current game environment.
	 */
	Environment getEnvironment();
	/**
	 * Resets the game context.
	 */
	void reset();
	/**
	 * Returns the level.
	 * @return The level.
	 */
	Level getLevel();
	/**
	 * Called when a tile collision has occurred between a model and tile.
	 * @param modelType The model type.
	 * @param tileLoc The location of the tile that has been collided with.
	 */
	void tileCollisionOccured(ModelType modelType, Point tileLoc);
}
